<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class program_build_failure</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute">
<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_hpp" title="Header &lt;boost/compute/exception/program_build_failure.hpp&gt;">
<link rel="prev" href="opencl_error.html" title="Class opencl_error">
<link rel="next" href="unsuppor_idm45822166163536.html" title="Class unsupported_extension_error">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="opencl_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unsuppor_idm45822166163536.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.compute.program_build_failure"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class program_build_failure</span></h2>
<p>boost::compute::program_build_failure — A failure when building OpenCL program. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_hpp" title="Header &lt;boost/compute/exception/program_build_failure.hpp&gt;">boost/compute/exception/program_build_failure.hpp</a>&gt;

</span>
<span class="keyword">class</span> <a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">opencl_error</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="program_build_failure.html#boost.compute.program_build_failureconstruct-copy-destruct">construct/copy/destruct</a></span>
  <span class="keyword">explicit</span> <a class="link" href="program_build_failure.html#idm45822166171296-bb"><span class="identifier">program_build_failure</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="program_build_failure.html#idm45822166167312-bb"><span class="special">~</span><span class="identifier">program_build_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="program_build_failure.html#idm45822166173456-bb">public member functions</a></span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="program_build_failure.html#idm45822166172896-bb"><span class="identifier">build_log</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm46604977147440"></a><h2>Description</h2>
<p>Instances of this class are thrown when OpenCL program build fails. Extends <a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> by saving a program build log so it can be used for testing, debugging, or logging purposes.</p>
<p><span class="bold"><strong>See Also:</strong></span></p>
<p><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> </p>
<p>
</p>
<p>
</p>
<div class="refsect2">
<a name="idm46604977143744"></a><h3>
<a name="boost.compute.program_build_failureconstruct-copy-destruct"></a><code class="computeroutput">program_build_failure</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45822166171296-bb"></a><span class="identifier">program_build_failure</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> build_log<span class="special">)</span><span class="special">;</span></pre>
<p>Creates a new <code class="computeroutput"><a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a></code> exception object for <code class="computeroutput">error</code> and <code class="computeroutput">build_log</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idm45822166167312-bb"></a><span class="special">~</span><span class="identifier">program_build_failure</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a></code> object. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm46604977124016"></a><h3>
<a name="idm45822166173456-bb"></a><code class="computeroutput">program_build_failure</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm45822166172896-bb"></a><span class="identifier">build_log</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Retrieve the log of a failed program build. </li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="opencl_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="unsuppor_idm45822166163536.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
